Restructure the org profile README and remove dead links - #29
Merged
Conversation
Rebuilds the page on the shape of the Model Context Protocol org profile README: logo, badges, tagline, nav, intro, Getting Started, Project Structure, then the tail sections. Link fixes: - codeanalyzer-ts and cocoa-py resolved only via GitHub rename redirects - the Discord link was a discord.com/channels deep-link, which resolves only for existing members; replaced with the public invite - the Contact table displayed rangeet.pan@ibm.com but the mailto pointed at gmail - the <picture> fallback <img> had no src attribute - badge.fury.io and opensource.org/licenses both redirected; pointed at their canonical targets Removed: the Supported Languages table (backends moved into Project Structure, status collapsed to one sentence), the Language-Specific Analysis Backends section, Build with CLDK and every COCOA reference, the duplicated Documentation and Examples section, the second code example, the commented-out npm badge, and links to the go/rust stubs and the 0.0.0-pre-alpha npm package. 143 lines to 104.
rahlk
force-pushed
the
docs/issue-28-readme-cleanup
branch
from
August 3, 2026 16:29
3a387bf to
6239a0c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation and Context
Closes #28.
Rebuilds the org profile README on the shape of the Model Context Protocol org profile README: logo, badges, tagline, nav, intro, Getting Started, Project Structure, then the tail sections.
Two deliberate departures from MCP, because CLDK is a library and MCP is a protocol: the badge row stays, and one code example stays. MCP's call to action is "read the spec"; CLDK's is
pip install cldk.Link fixes
codeanalyzer-tsandcocoa-pyresolved only via GitHub rename redirectsdiscord.com/channelsdeep-link, resolving only for existing membersrangeet.pan@ibm.comwhile themailto:pointed at gmail<picture>fallback<img>had nosrcattributebadge.fury.ioandopensource.org/licensesboth redirected; now canonicalRemoved
The Supported Languages table (backends moved into Project Structure, status collapsed to one sentence), the Language-Specific Analysis Backends section, Build with CLDK and every COCOA reference, the duplicated Documentation and Examples section, the second code example, the commented-out npm badge, and links to the
codeanalyzer-go/codeanalyzer-ruststubs and the0.0.0-pre-alphanpm package.143 lines to 104.
How Has This Been Tested?
Every URL extracted from the rendered file and checked for both status and redirect. All return 200 with no redirect, except
discord.gg/zEjz9YrmqN, whose 301 todiscord.com/invite/…is Discord's own canonical shortener and is by design.All four shields.io badge images return 200. The relative
CONTRIBUTING.mdtarget and both logo assets exist. Everymailto:was compared against its display text — all three now match. Verified zero occurrences of "cocoa".Rendering on the actual org profile page cannot be verified before merge.
Breaking Changes
None. Documentation only.
Types of changes
Checklist
Additional context
Propagation sweep.
cocoa-pyand thediscord.com/channelsdeep-link appear nowhere else in the org.codeanalyzer-tsis widespread but almost always as the legitimate binary/tool name — the published npm package iscodeanalyzer-typescriptwith bincants. Two genuine stale repo references remain elsewhere and are filed separately:codeanalyzer-typescript/packaging/python/pyproject.toml:27—Repository = "https://github.com/codellm-devkit/codeanalyzer-ts", which ships as published package metadatacodeanalyzer-typescript/packaging/homebrew/generate_formula.sh:15,21— staleREPOexample and defaultA
python-sdktest fixture also contains the string as recorded path data rather than a link; not investigated further.